/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsrm.storage;

/** This provides operations for storing and retrieving information 
    pertaining to Sequences. Specifically the operations provided include
    <br>(a)Storing and Retrieving SequenceInfo objects 
    <br>(b) Retrieving the list of all sent, received, created, expired,
    terminated and active sent and received Sequences. 
    
    @author Shrideep Pallickara, Sangmi Lee and Beytullah Yildiz
    $Date: 2005/07/29 22:41:30 $
    $Revision: 1.4 $
*/

public interface WsrmSequenceInfoStorageOperations {

  /** Stores the sequence identifier that should be used while communicating
      with a given destination (based on the contents of the wsa:To element).
      This feature allows us to send messages reliably with minimal 
      intervention from the application.*/
  public void 
  addDestinationSequenceIdentifierPair(String destination, 
				       String sequenceIdentifier) 
    throws WsrmStorageException;
  

  /** Retrieve the sequence identifier for a specific destination */
  public String getSequenceIdentifierForDestination(String destination)
    throws WsrmStorageException;

  
  /** Retrieves the destination for a specific sequence identifier */
  public String 
  getDestinationForSequenceIdentifier(String sequenceIdentifier)
    throws WsrmStorageException;
  
  
  /** Removes the destination/sequence identifier pair corresponding to this
      destination */
  public void
  removeDestinationSequenceIdentifierPair(String destination)
    throws WsrmStorageException;
  
  
  
  /** Checks to see if there is a sequenceId/destination pair corresponding
      to the destination in question. */
  public boolean
  hasSequenceIdForDestination(String destination) 
    throws WsrmStorageException;



  /** A method which checks whether a certain sequence (irrespective of whether
      it is active/terminated/expired/timed-out) is a known sequence at this
      node */
  public boolean
  isKnownSequence(String sequenceIdentifier) 
    throws WsrmStorageException;


  /** Store a SequenceInfo object. This method throws an exception under the
      following circumstances
      <br> The sequenceIdentifier in the SequenceInfo already exists.
      <br> Storage related problems */
  public void storeCreatedSequence(WsrmSequenceInfo sequenceInfo)
    throws WsrmStorageException;
  


  /** Retrieves the SequenceInfo corresponding to the specified 
      sequenceIdentifier. This method throws an exception under the following 
      conditions.
      <br> The Sequence specified in sequenceIdentifier is an unknown one.
      <br> Storage related problems */
  public WsrmSequenceInfo 
  getSequenceInfoUsingSequenceIdentifier(String sequenceIdentifier)
    throws WsrmStorageException;



  /** Retrieves the SequenceInfo corresponding to the ACTIVE sequences with 
      the specified sequenceIdentifier prefix. 
      This method throws an exception under the following conditions.
      <br> The Sequence specified in sequenceIdentifier is an unknown one.
      <br> Storage related problems */
  public WsrmSequenceInfo[] 
  getSequenceInfoUsingSequencePrefix(String sequencePrefix)
    throws WsrmStorageException;



  /** Retrieves the SequenceInfo corresponding to the specified 
      addressingIdentifier. This method throws an exception under the 
      following conditions.
      <br> The Sequence specified in addressingIdentifier is an unknown one.
      <br> Storage related problems */
  public WsrmSequenceInfo 
  getSequenceInfoUsingAddressingIdentifier(String addressingIdentifier)
    throws WsrmStorageException;

  
  
  
  /** Retrieves the entire list of sent/received sequence identifiers 
      registered with the underlying service. This method throws an exception 
      if  there are storage related problems. */
  public String[] getListOfAllSequences(boolean source) 
    throws WsrmStorageException;

  

  

  /** Retrieves the list of sent/received sequences that have expired. This 
      method throws an exception if there are storage related problems. */
  public String[] getListOfExpiredSequences(boolean source) 
    throws WsrmStorageException;




  /** Retrieves the list of sent/received sequences that have timed-out. This 
      method throws an exception if there are storage related problems. */
  public String[] getListOfTimedOutSequences(boolean source) 
    throws WsrmStorageException;




  
  /** Retrieves the list of sent/received sequences that have terminated. This 
      method throws an exception if there are storage related problems. */
  public String[] getListOfTerminatedSequences(boolean source) 
    throws WsrmStorageException;





  /** Retrieves the list of sent/received sequences that have been 
      acknowledged and were successfully terminated. These sequences are ones
      where the sequence DID NOT EXPIRE or had an INACTIVITY_TIMEOUT. Also
      the LAST MESSAGE information should be present.
      This method throws an exception if there are storage related problems. */
  public String[] getListOfServicedSequences(boolean source)  
    throws WsrmStorageException;
  

  
  
  /** Retrieves the list of active sent/received sequences that are currently 
      available at this node.  This method throws an exception if there are 
      storage related problems.*/
  public String[] getListOfActiveSequences(boolean source)
    throws WsrmStorageException;
  
}







